/Services/SetSignatureRequestParameters (Method)

Description

Set parameters for a file.

Request (SetSignatureRequestParametersSoapIn)

The request body is of type SetSignatureRequestParameters.

Request Body Parameters

Name	Description	Data Type
p_ApiCode	The API code of the site. This can be found through your Sertifi web interface under Administration -> Account Settings.	xml:string
p_FileID	The id of the relevant file.	xml:string
p_XMLContent	XML specifying properties to update. See example for available parameters.	xml:string
p_CustomMetadataXML	To specify customer specific metadata to be a part of document database (this uses the same format as pre-fill XML)	xml:string

Response (SetSignatureRequestParametersSoapOut)

The response body is of type SetSignatureRequestParametersResponse.

Response Body Parameters

Name	Description	Data Type
SetSignatureRequestParametersResult	"SUCCESS", warnings or error message. Warnings indicate partial success; errors indicate no success.	xml:string

Example

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://apps.sertifi.net/services/">
   <soap:Header/>
   <soap:Body>
      <ser:SetSignatureRequestParameters>
         
         <ser:p_ApiCode>88F54943-115A-4BD7-B325-52262BCA2F98</ser:p_ApiCode>
         
         <ser:p_FileID>XlhsT3KlhAs=</ser:p_FileID>
         
         <ser:p_XMLContent>
           <![CDATA[<?xml version='1.0' encoding='UTF-8' ?><file>
      <parameter name='MaskEmailsFromClient' value='true' />
      <parameter name='IDCheck' value='true' email='' />
      <parameter name='FileNumericId1' value='Integer' />
      <parameter name='MustSignWithName' email='[email protected]' value='Any Name' preFillName='true'/>
      <parameter name='DefaultLanguage' value='en|es|fr-CA'/>
      <parameter name='SecurityQuestion' email='[email protected]' prompt='Question' value='Answer'/>
      <parameter name='EmailGroupName' value='Sales Group'/>
      <parameter name='FolderExpiresOn' value='2012-05-24'/>
      <parameter name='ConsolidatedSigning' value='true'/>
    </file>]]>
     </ser:p_XMLContent>
         
         <ser:p_CustomMetadataXML><![CDATA[<?xml version="1.0" encoding="UTF-8"?><record><field Name="PDF field name" Text="value" /><field Name="PDF field name2" Text="value" /></record>]]></ser:p_CustomMetadataXML>
      </ser:SetSignatureRequestParameters>
   </soap:Body>
</soap:Envelope>

Remarks

Common Errors include:
"ERROR: Invalid API Code"
"ERROR: File could not be accessed."
"ERROR: could not parse custom metadata"
"ERROR: Invalid parameter attributes 'email': ..."
"ERROR: Invalid parameter attributes. Signer ..."
"ERROR: Invalid parameter attributes."
"ERROR: invalid value in one of IDCheck parameters."
"ERROR: invalid value in maskemailsfromclient parameter."
"ERROR: Must specify e-mail address for MustSignWithName parameter. Name passed: ..."
"ERROR: enablemousesignature is disabled for this account."
"ERROR: invalid value in one of enablemousesignature parameters."
"ERROR: ... is not a supported language"
"ERROR: Security prompt cannot be longer than 200 characters. Email: ..."
"ERROR: Password cannot be longer than 200 characters. Email: ..."
"ERROR: ... email group is either not present or does not have any e-mail templates defined."
"ERROR: Cannot set expiration date for a folder beyond 365 days from now. Value passed: ..."
"ERROR: ... is not a properly formatted date. Expected format yyyy-mm-dd (four digit year followed by a two digit month, followed by a two digit day)"
"ERROR: invalid value in ConsolidatedSigning parameter."
"ERROR: Consolidated Signing not available for this account. If you would like this feature, please contact our sales or support team."
"ERROR: Invalid ... value."
"ERROR: Invalid XML."
"ERROR: File remain unchanged."

Common Warnings include:
"... is not a valid File External Id. Valid parameters are FileExternalId1 - FileExternalId10."
"The passed value of ... exceeded the maximum length of 100 for parameter {0} and was truncated."
"... is not a valid File Numberic Id. Valid parameters is FileNumericId1."
"... is not a valid File Numberic Id. Valid parameters is FileNumbericId1."
"... has invalid File Numberic Id value."